<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>axiethernet: Examples</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">axiethernet
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li class="current"><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('example.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">Examples </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>You can refer to the below stated example applications for more details which gives an idea of how the Axi Ethernet and its driver are intended to be used.</p>
<p>SYSTEM REQUIREMENTS: The system containing the Axi Ethernet should have the following capabilities:</p>
<ul>
<li>An interrupt controller</li>
<li>An external memory controller with at least 200KB of RAM available</li>
<li>A UART to display messages</li>
<li>The reset line of the device connected to the AxiEthernet AXI4-Stream interface (AXIDMA or AXIFIFO) must be connected to the reset line of AxiEthernet. (By default for BSB generated systems this is the case.)</li>
</ul>
<h1><a class="anchor" id="ex1"></a>
xaxiethernet_example_extmulticast.c</h1>
<p>Contains an example on how to use the XAxietherent driver directly. This example uses the AXI Ethernet's interrupt driven DMA packet transfer mode to send and receive multicast frames when XAE_EXT_MULTICAST_OPTION is enabled.</p>
<p>For details, see <a class="el" href="xaxiethernet__example__extmulticast_8c.html" title="Implements examples that utilize the AXI Ethernet&#39;s interrupt driven DMA packet transfer mode to send...">xaxiethernet_example_extmulticast.c</a>.</p>
<h1><a class="anchor" id="ex2"></a>
xaxiethernet_example_extvlan.c</h1>
<p>Contains an example on how to use the XAxietherent driver directly. This example uses the Axi Ethernet's interrupt driven SGDMA packet transfer mode to send and receive frames.</p>
<p>For details, see <a class="el" href="xaxiethernet__example__extvlan_8c.html" title="Implements examples that utilize the Axi Ethernet&#39;s interrupt driven SGDMA packet transfer mode to se...">xaxiethernet_example_extvlan.c</a>.</p>
<h1><a class="anchor" id="ex3"></a>
xaxiethernet_example_intr_fifo.c</h1>
<p>Contains an example on how to use the XAxietherent driver directly. This example uses the Axi Ethernet's interrupt driven FIFO direct packet transfer mode to send and receive frames. HW must be setup for FIFO direct mode.</p>
<p>For details, see <a class="el" href="xaxiethernet__example__intr__fifo_8c.html" title="Implements examples that utilize the Axi Ethernet&#39;s interrupt driven FIFO direct packet transfer mode...">xaxiethernet_example_intr_fifo.c</a>.</p>
<h1><a class="anchor" id="ex4"></a>
xaxiethernet_example_intr_sgdma.c</h1>
<p>Contains an example on how to use the XAxietherent driver directly. This example uses the Axi Ethernet's interrupt driven SGDMA packet transfer mode to send and receive frames. HW must be setup for checksum offloading for this example to properly execute.</p>
<p>For details, see <a class="el" href="xaxiethernet__example__intr__sgdma_8c.html" title="Implements examples that utilize the Axi Ethernet&#39;s interrupt driven SGDMA packet transfer mode to se...">xaxiethernet_example_intr_sgdma.c</a>.</p>
<h1><a class="anchor" id="ex5"></a>
xaxiethernet_example_polled.c</h1>
<p>Contains an example on how to use the XAxietherent driver directly. This example uses the Axi Ethernet's FIFO direct frame transfer mode in a polled fashion to send and receive frames. HW must be setup for FIFO direct mode.</p>
<p>For details, see <a class="el" href="xaxiethernet__example__polled_8c.html" title="Implements examples that utilize the Axi Ethernet&#39;s FIFO direct frame transfer mode in a polled fashi...">xaxiethernet_example_polled.c</a>.</p>
<h1><a class="anchor" id="ex6"></a>
xaxiethernet_example_util.c</h1>
<p>Contains an example on how to use the XAxietherent driver directly. This example implements the utility functions for debugging, and ethernet frame construction.</p>
<p>For details, see <a class="el" href="xaxiethernet__example__util_8c.html" title="This file implements the utility functions for the Axi Ethernet example code. ">xaxiethernet_example_util.c</a>.</p>
<h1><a class="anchor" id="ex7"></a>
xaxiethernet_example_mcdma_poll.c</h1>
<p>Contains an example on how to use the XAxietherent driver directly. This example shows how to use Axi Ethernet with MCDMA in polled mode to send and receive frames.</p>
<p>For details, see <a class="el" href="xaxiethernet__example__mcdma__poll_8c.html" title="Implements examples that utilize the Axi Ethernet&#39;s polled mode MCDMA packet transfer mode to send an...">xaxiethernet_example_mcdma_poll.c</a>.</p>
<h1><a class="anchor" id="ex8"></a>
xaxiethernet_example_intr_mcdma.c</h1>
<p>Contains an example on how to use the XAxietherent driver directly. This example shows how to use Axi Ethernet with MCDMA in interrupt mode to send and receive frames.</p>
<p>For details, see <a class="el" href="xaxiethernet__example__intr__mcdma_8c.html" title="Implements examples that utilize the Axi Ethernet&#39;s interrupt driven MCDMA packet transfer mode to se...">xaxiethernet_example_intr_mcdma.c</a>.</p>
<h1><a class="anchor" id="ex9"></a>
xaxiethernet_mcdma_ping_req_example.c</h1>
<p>Contains an example on how to use the XAxietherent driver directly. This example shows how to use Axi Ethernet with MCDMA in polled mode to send ping request's.</p>
<p>For details, see <a class="el" href="xaxiethernet__mcdma__ping__req__example_8c.html" title="This file contains a Axi Ethernet MCDMA Ping request example in polled mode. ">xaxiethernet_mcdma_ping_req_example.c</a>.</p>
<h1><a class="anchor" id="ex10"></a>
xaxiethernet_example.h</h1>
<p>This headerfile defines common data types, prototypes, and includes the proper headers for use with the Axi Ethernet examples.</p>
<p>For details, see <a class="el" href="xaxiethernet__example_8h.html" title="Defines common data types, prototypes, and includes the proper headers for use with the Axi Ethernet ...">xaxiethernet_example.h</a>.</p>
<h2><a class="anchor" id="INCLUDING"></a>
EXAMPLES IN EDK:</h2>
<ul>
<li>Each example is independent from the others except for common code found in <a class="el" href="xaxiethernet__example__util_8c.html" title="This file implements the utility functions for the Axi Ethernet example code. ">xaxiethernet_example_util.c</a>. When including source code files in an EDK SW application, select <a class="el" href="xaxiethernet__example__util_8c.html" title="This file implements the utility functions for the Axi Ethernet example code. ">xaxiethernet_example_util.c</a> along with one other example source code file.</li>
</ul>
<h2><a class="anchor" id="IMPORTANT"></a>
NOTES:</h2>
<ul>
<li>Included HW features are critical as to which examples will run properly.</li>
<li>The device connected to the AXI4-Stream interface (AXIFIFO or AXIDMA or AXI MCDMA) of the AxiEthernet must be initialized before AxiEthernet initialization. Since the reset line of AXIFIFO or AXIDMA or AXI MCDMA is connected to the reset line of AxiEthernet, AXIDMA/AXIFIFO/AXI MCDMA initialization would reset AxiEthernet. AxiEthernet hardware initialization routines in the AxiEthernet driver do not reset the AxiEthernet hardware. </li>
</ul>
</div></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
